home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgramD2.iso / Borland / Borland C++ V5.02 / RTLWIN32.PAK / CPL.H < prev    next >
C/C++ Source or Header  |  1997-05-06  |  8KB  |  218 lines
  1. /*****************************************************************************\
  2. *                                                                             *
  3. * cpl.h -       Control panel extension DLL definitions                       *
  4. *                                                                             *
  5. *               Version 3.10                                                  *
  6. *                                                                             *
  7. *               Copyright (c) 1992-1996, Microsoft Corp.  All rights reserved *
  8. *                                                                             *
  9. ******************************************************************************/
  10. /*
  11. *  General rules for being installed in the Control Panel:
  12. *
  13. *      1) The DLL must export a function named CPlApplet which will handle
  14. *         the messages discussed below.
  15. *      2) If the applet needs to save information in CONTROL.INI minimize
  16. *         clutter by using the application name [MMCPL.appletname].
  17. *      2) If the applet is refrenced in CONTROL.INI under [MMCPL] use
  18. *         the following form:
  19. *              ...
  20. *              [MMCPL]
  21. *              uniqueName=c:\mydir\myapplet.dll
  22. *              ...
  23. *
  24. *
  25. *  The order applet DLL's are loaded by CONTROL.EXE is not guaranteed.
  26. *  Control panels may be sorted for display, etc.
  27. *
  28. */
  29. #ifndef _INC_CPL
  30. #define _INC_CPL
  31. #pragma option -b
  32.  
  33.  
  34. #pragma option -b.
  35. #include <pshpack1.h>   /* Assume byte packing throughout */
  36. #pragma option -b
  37.  
  38. #ifdef __cplusplus
  39. extern "C" {            /* Assume C declarations for C++ */
  40. #endif /* __cplusplus */
  41.  
  42. /*
  43.  * CONTROL.EXE will answer this message and launch an applet
  44.  *
  45.  * WM_CPL_LAUNCH
  46.  *
  47.  *      wParam      - window handle of calling app
  48.  *      lParam      - LPTSTR of name of applet to launch
  49.  *
  50.  * WM_CPL_LAUNCHED
  51.  *
  52.  *      wParam      - TRUE/FALSE if applet was launched
  53.  *      lParam      - NULL
  54.  *
  55.  * CONTROL.EXE will post this message to the caller when the applet returns
  56.  * (ie., when wParam is a valid window handle)
  57.  *
  58.  */
  59. #define WM_CPL_LAUNCH   (WM_USER+1000)
  60. #define WM_CPL_LAUNCHED (WM_USER+1001)
  61.  
  62. /* A function prototype for CPlApplet() */
  63.  
  64. //typedef LRESULT (APIENTRY *APPLET_PROC)(HWND hwndCpl, UINT msg, LPARAM lParam1, LPARAM lParam2);
  65. typedef LONG (APIENTRY *APPLET_PROC)(HWND hwndCpl, UINT msg, LONG lParam1, LONG lParam2);
  66.  
  67. /* The data structure CPlApplet() must fill in. */
  68.  
  69. typedef struct tagCPLINFO
  70. {
  71.     int     idIcon;     /* icon resource id, provided by CPlApplet() */
  72.     int     idName;     /* name string res. id, provided by CPlApplet() */
  73.     int     idInfo;     /* info string res. id, provided by CPlApplet() */
  74.     LONG    lData;      /* user defined data */
  75. } CPLINFO, *LPCPLINFO;
  76.  
  77. typedef struct tagNEWCPLINFOA
  78. {
  79.     DWORD   dwSize;         /* similar to the commdlg */
  80.     DWORD   dwFlags;
  81.     DWORD   dwHelpContext;  /* help context to use */
  82.     LONG    lData;          /* user defined data */
  83.     HICON   hIcon;          /* icon to use, this is owned by CONTROL.EXE (may be deleted) */
  84.     CHAR    szName[32];     /* short name */
  85.     CHAR    szInfo[64];     /* long name (status line) */
  86.     CHAR    szHelpFile[128];/* path to help file to use */
  87. } NEWCPLINFOA, *LPNEWCPLINFOA;
  88. typedef struct tagNEWCPLINFOW
  89. {
  90.     DWORD   dwSize;         /* similar to the commdlg */
  91.     DWORD   dwFlags;
  92.     DWORD   dwHelpContext;  /* help context to use */
  93.     LONG    lData;          /* user defined data */
  94.     HICON   hIcon;          /* icon to use, this is owned by CONTROL.EXE (may be deleted) */
  95.     WCHAR   szName[32];     /* short name */
  96.     WCHAR   szInfo[64];     /* long name (status line) */
  97.     WCHAR   szHelpFile[128];/* path to help file to use */
  98. } NEWCPLINFOW, *LPNEWCPLINFOW;
  99. #ifdef UNICODE
  100. typedef NEWCPLINFOW NEWCPLINFO;
  101. typedef LPNEWCPLINFOW LPNEWCPLINFO;
  102. #else
  103. typedef NEWCPLINFOA NEWCPLINFO;
  104. typedef LPNEWCPLINFOA LPNEWCPLINFO;
  105. #endif // UNICODE
  106.  
  107. #if(WINVER >= 0x0400)
  108. #define CPL_DYNAMIC_RES 0
  109. // This constant may be used in place of real resource IDs for the idIcon,
  110. // idName or idInfo members of the CPLINFO structure.  Normally, the system
  111. // uses these values to extract copies of the resources and store them in a
  112. // cache.  Once the resource information is in the cache, the system does not
  113. // need to load a CPL unless the user actually tries to use it.
  114. // CPL_DYNAMIC_RES tells the system not to cache the resource, but instead to
  115. // load the CPL every time it needs to display information about an item.  This
  116. // allows a CPL to dynamically decide what information will be displayed, but
  117. // is SIGNIFICANTLY SLOWER than displaying information from a cache.
  118. // Typically, CPL_DYNAMIC_RES is used when a control panel must inspect the
  119. // runtime status of some device in order to provide text or icons to display.
  120.  
  121. #endif /* WINVER >= 0x0400 */
  122.  
  123. /* The messages CPlApplet() must handle: */
  124.  
  125. #define CPL_INIT        1
  126. /*  This message is sent to indicate CPlApplet() was found. */
  127. /*  lParam1 and lParam2 are not defined. */
  128. /*  Return TRUE or FALSE indicating whether the control panel should proceed. */
  129.  
  130.  
  131. #define CPL_GETCOUNT    2
  132. /*  This message is sent to determine the number of applets to be displayed. */
  133. /*  lParam1 and lParam2 are not defined. */
  134. /*  Return the number of applets you wish to display in the control */
  135. /*  panel window. */
  136.  
  137.  
  138. #define CPL_INQUIRE     3
  139. /*  This message is sent for information about each applet. */
  140.  
  141. /*  A CPL SHOULD HANDLE BOTH THE CPL_INQUIRE AND CPL_NEWINQUIRE MESSAGES. */
  142. /*  The developer must not make any assumptions about the order or dependance */
  143. /*  of CPL inquiries. */
  144.  
  145. /*  lParam1 is the applet number to register, a value from 0 to */
  146. /*  (CPL_GETCOUNT - 1).  lParam2 is a far ptr to a CPLINFO structure. */
  147. /*  Fill in CPLINFO's idIcon, idName, idInfo and lData fields with */
  148. /*  the resource id for an icon to display, name and description string ids, */
  149. /*  and a long data item associated with applet #lParam1.  This information */
  150. /*  may be cached by the caller at runtime and/or across sessions. */
  151. /*  To prevent caching, see CPL_DYNAMIC_RES, above.  */
  152.  
  153.  
  154. #define CPL_SELECT      4
  155. /*  The CPL_SELECT message has been deleted. */
  156.  
  157.  
  158. #define CPL_DBLCLK      5
  159. /*  This message is sent when the applet's icon has been double-clicked */
  160. /*  upon.  lParam1 is the applet number which was selected.  lParam2 is the */
  161. /*  applet's lData value. */
  162. /*  This message should initiate the applet's dialog box. */
  163.  
  164.  
  165. #define CPL_STOP        6
  166. /*  This message is sent for each applet when the control panel is exiting. */
  167. /*  lParam1 is the applet number.  lParam2 is the applet's lData  value. */
  168. /*  Do applet specific cleaning up here. */
  169.  
  170.  
  171. #define CPL_EXIT        7
  172. /*  This message is sent just before the control panel calls FreeLibrary. */
  173. /*  lParam1 and lParam2 are not defined. */
  174. /*  Do non-applet specific cleaning up here. */
  175.  
  176.  
  177. #define CPL_NEWINQUIRE    8
  178. /* Same as CPL_INQUIRE execpt lParam2 is a pointer to a NEWCPLINFO struct. */
  179.  
  180. /*  A CPL SHOULD HANDLE BOTH THE CPL_INQUIRE AND CPL_NEWINQUIRE MESSAGES. */
  181. /*  The developer must not make any assumptions about the order or dependance */
  182. /*  of CPL inquiries. */
  183.  
  184. #if(WINVER >= 0x0400)
  185. #define CPL_STARTWPARMSA 9
  186. #define CPL_STARTWPARMSW 10
  187. #ifdef UNICODE
  188. #define CPL_STARTWPARMS CPL_STARTWPARMSW
  189. #else
  190. #define CPL_STARTWPARMS CPL_STARTWPARMSA
  191. #endif
  192.  
  193. /* this message parallels CPL_DBLCLK in that the applet should initiate
  194. ** its dialog box.  where it differs is that this invocation is coming
  195. ** out of RUNDLL, and there may be some extra directions for execution.
  196. ** lParam1: the applet number.
  197. ** lParam2: an LPSTR to any extra directions that might exist.
  198. ** returns: TRUE if the message was handled; FALSE if not.
  199. */
  200. #endif /* WINVER >= 0x0400 */
  201.  
  202.  
  203. /* This message is internal to the Control Panel and MAIN applets.  */
  204. /* It is only sent when an applet is invoked from the Command line  */
  205. /* during system installation.                                      */
  206. #define CPL_SETUP               200 
  207.  
  208. #ifdef __cplusplus
  209. }
  210. #endif    /* __cplusplus */
  211.  
  212. #pragma option -b.
  213. #include <poppack.h>
  214. #pragma option -b
  215.  
  216. #pragma option -b.
  217. #endif  /* _INC_CPL */
  218.